/**
 * Copyright (c) 2010 Basil Shikin, BugStat Project
 * 
 * Permission is hereby granted, free of charge, to any person obtaining a copy
 * of this software and associated documentation files (the "Software"), to deal
 * in the Software without restriction, including without limitation the rights
 * to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
 * copies of the Software, and to permit persons to whom the Software is
 * furnished to do so, subject to the following conditions:
 * 
 * The above copyright notice and this permission notice shall be included in
 * all copies or substantial portions of the Software.
 * 
 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
 * IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
 * FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
 * AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
 * LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
 * OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN
 * THE SOFTWARE.
 */
package org.bugstat.renderers;

import java.io.File;
import java.io.IOException;
import java.util.Collection;
import java.util.List;

import org.bugstat.common.reports.Report;
import org.bugstat.common.utils.ProgressListener;

/**
 * This interface defines a class that can render a report. Report rendering is one (or several files) that is generated on disk
 * under a given folder.
 *
 * @author Basil Shikin
 *
 */
public interface ReportRenderer
{
    /**
     * Render given reports into a given folder.
     * 
     * @param report             Reports to render. Must not be null.
     * @param folder             Folder to write rendered files into. Must not be null. Must be a folder.
     * @param reportInformation  General information about reports (i.e. metadata). Must not be null.
     * @param progressListener   Listener to notify of report progress
     * 
     * @return Collection of all files that are report rendering.
     * 
     * @throws IOException In case unable to render the report. 
     */
    public Collection<File> renderReports( final List<Report> reports, final ReportInformation reportInformation, final File folder, final ProgressListener listener ) throws IOException;
    
    /**
     * Get localized renderer name. String should answer user's question: "What is a format of generated
     * report report?". Answers may be 'CSV files', 'HTML pages', etc.
     * 
     * @return User-friendly renderer name
     */
    public String getName();
}
